Skip to main content
Version: 1.0.2

Replace Card - Reissue Card

REISSUE - A replacement card is issued on retaining the same Primary Account Number (PAN) as the original card.

REPLACE - A replacement card is issued with a new Primary Account Number (PAN).

Method: POST​

{{URL}}/cardv2

Headers​

NameValue
Content-Typeapplication/json

Example​

Payload Parameters
ParametersDescription

reference

Optional

String

Unique reference ID of the request

Sample Value: "visadps100017"

product

Mandatory

String

Name of the product associated with the card

Sample Value: "DEFAULT"

program

Mandatory

String

Name of the program to which the card product is mapped

Sample Value: "DEFAULT"

channel

Mandatory

Enum

Processing channel through which the card transaction happens

Valid Values:

PULSE

VISA_DPS

Sample Value: "VISA_DPS"

transactionType

Mandatory

String

Type of operation / transaction

Constant Value: "REPLACE_CARD"

customerId

Mandatory

String

Unique ID of customer who holds the card

Sample Value: "100000000006001"

cardId

Mandatory

String

Unique ID of the card

Sample Value: "6f586be7bf1c44b8b4ea11b2e2510e25"

accountNumber

Mandatory

String

Account number linked to the card

Sample Value: "400320588344662"

statusAction

Mandatory

Enum

Card has to be either replaced or reissued

Valid Values:

REPLACE_CARD

REISSUE

Sample Value: "REPLACE_CARD"


curl --location --globoff --request GET '{{URL}}/cardv2' \
--header 'Content-Type: application/json' \
--data '{"method":"ledger.CARD.request","id":"1","params":{"payload":{"reference":"visadps100017","product":"DEFAULT","program":"DEFAULT","channel":"VISA_DPS","transactionType":"REPLACE_CARD","customerId":"100000000006001","cardId":"6f586be7bf1c44b8b4ea11b2e2510e25","accountNumber":"400320588344662","statusAction":"REPLACE_CARD"},"api":{"credential":"{{cred}}","signature":"{{signature}}","apiKey":"{{Api-key}}"}}}'

Body​


{
    "method": "ledger.CARD.request",
    "id": "1",
    "params": {
        "payload": {
            "reference": "visadps100017",
            "product": "DEFAULT",
            "program": "DEFAULT",
            "channel": "VISA_DPS",
            "transactionType": "REPLACE_CARD",
            "customerId": "100000000006001",
            "cardId": "6f586be7bf1c44b8b4ea11b2e2510e25",
            "accountNumber": "400320588344662",
            "statusAction": "REPLACE_CARD"
        },
        "api": {
            "credential": "{{cred}}",
            "signature": "{{signature}}",
            "apiKey": "{{Api-key}}"
        }
    }
}

Response: 200​

Response Parameters
ParametersDescription

Id

String

Response ID echoed from the request ID

Sample Value: "1"

result

Object

card

Object

cardId

String

Unique ID of the card

Sample Value: "6f586be7bf1c44b8b4ea11b2e2510e25"

cardHolderId

String

Unique ID of the card holder

Sample Value: "CH00000000020003"

cardHolderName

String

Name of the card holder

Sample Value: "Matthew Sandra"

cardProduct

String

ID of the card product associated to the card

Sample Value: "2c6b841a-dfc1-4a6a-a12a-13c21035b5be"

customerId

String

Unique ID of customer who holds the card

Sample Value: "100000000006001"

accountId

String

Unique ID of the account linked to the card

Sample Value: "332004"

product

String

Name of the product associated with the card

Sample Value: "DEFAULT"

program

String

Name of the program to which the card product is mapped

Sample Value: "DEFAULT"

cardType

String

Whether thecard is physical or virtual

Sample Value: "PHYSICAL"

postedDate

String

Date and time when the request for replace / reissue card status was posted

Sample Value: "2024-11-20T06:54:26.822Z"

updatedDate

String

Date and time when the status was updated

Sample Value: "2024-11-20T07:25:56.513Z"

cardMaskNumber

String

Masked representation of the card number

Sample Value: "************5461"

cardNumber

String

Encrypted card number

Sample Value: "649f748bd576e66fdb4f2100bb79a91c"

cardStatus

String

Current status of the card

Sample Value: "LOST_STOLEN"

cardExpiryDate

String

Expiration date of the card in YYYYMM format

Sample Value: "202611"

allowAtm

Boolean

Allowing card for transactions through ATM

Sample Value: true

allowEcommerce

Boolean

Allowing card for e-commerce transactions

Sample Value: true

allowMoto

Boolean

Allowing card for transactions through mobile

Sample Value: true

allowPos

Boolean

Allowing card for point-of-sale (POS) terminal transaction

Sample Value: true

allowTips

Boolean

Allowing card for tips transaction

Sample Value: true

allowPurchase

Boolean

Allowing card for purchase transaction

Sample Value: true

allowRefund

Boolean

Allowing card for refund transaction

Sample Value: true

allowCashback

Boolean

Allowing card for cashback transaction

Sample Value: true

allowWithdraw

Boolean

Allowing card for ATM withdrawal transaction

Sample Value: false

allowAuthAndCompletion

Boolean

Allowing for authorization and completion of transaction that happens through card

Sample Value: false

smart

Boolean

Allowing card for smart transaction

Sample Value: true

checkAvsZip

Boolean

Allowing card to perform AVS checks on the legalRep ZIP code during transaction

Sample Value: true

checkAvsAddr

Boolean

Allowing card to perform AVS checks on the legalRep address during transaction

Sample Value: true

cvv

String

Card Verification Value of the card

Sample Value: ""

accountNumber

String

Account number linked to the card

Sample Value: "400320588344662"

cardName

String

Name printed on the card

Sample Value: "Matthew Sandra"

patterns

Array

Patterns of the card

Sample Value: "CARDNUMBER:5461"

transactionMade

Boolean

Inicates whether any transactions have been made using the card or not

Sample Value: false

orderStatus

String

Current order status of the card

Sample Value: "ORDER_PLACED"

orderId

String

Unique ID of the card order

Sample Value: "4UOO1ER8E6SV000"

network

String

Card network

Sample Value: "VISA_DPS"

isReIssue

Boolean

Inicates whether the card is reissued

Sample Value: false

isReplace

Boolean

Inicates whether the card replaced

Sample Value: false

externalCardId

String

Unique card ID that links the card and the external processor

Sample Value: "v-401-27c8bce1-1178-4282-8541-ae8401e65d0e"

cardCreatedYear

String

Year when the card was created

Sample Value: "2024"

orderSubStatus

String

Substatus that provides further details about the card order process

Sample Value: "ORDER_PENDING"

accountName

String

Account name associated with the card

Sample Value: "David Savings Account"

customerName

String

Customer name associated with the card

Sample Value: "David Test"

api

Object

type

String

Acknowledgement for type of operation requested for

Sample Value: "REPLACE_CARD_ACK"

reference

String

Unique reference for the API response

Sample Value: "REFvisadps100017"

dateCreated

Number

Unix timestamp of the response was created

Sample Value: 1732087711

originalReference

String

Original reference ID taken from the request

Sample Value: "visadps100017"


{
    "id": "1",
    "result": {
        "card": {
            "cardId": "6f586be7bf1c44b8b4ea11b2e2510e25",
            "cardHolderId": "CH00000000020003",
            "cardHolderName": "Matthew Sandra",
            "cardProduct": "2c6b841a-dfc1-4a6a-a12a-13c21035b5be",
            "customerId": "100000000006001",
            "accountId": "332004",
            "product": "DEFAULT",
            "program": "DEFAULT",
            "cardType": "PHYSICAL",
            "postedDate": "2024-11-20T06:54:26.822Z",
            "updatedDate": "2024-11-20T07:25:56.513Z",
            "cardMaskNumber": "************5461",
            "cardNumber": "649f748bd576e66fdb4f2100bb79a91c",
            "cardStatus": "LOST_STOLEN",
            "cardExpiryDate": "202611",
            "allowAtm": true,
            "allowEcommerce": true,
            "allowMoto": true,
            "allowPos": true,
            "allowTips": true,
            "allowPurchase": true,
            "allowRefund": true,
            "allowCashback": true,
            "allowWithdraw": false,
            "allowAuthAndCompletion": false,
            "smart": true,
            "checkAvsZip": true,
            "checkAvsAddr": true,
            "cvv": "",
            "accountNumber": "400320588344662",
            "cardName": "Matthew Sandra",
            "patterns": [
                "CARDNUMBER:5461",
                "DATE:20112024",
                "CARDHOLDERNAME:MATTHEW SANDRA",
                "CARDNAME:MATTHEW SANDRA",
                "ACCOUNTNUMBER:400320588344662",
                "CUSTOMERID:100000000006001",
                "ACCOUNTNAME:DAVID SAVINGS ACCOUNT",
                "CUSTOMERNAME:DAVID TEST",
                "CARDSTATUS:CARD_IS_NOT_ACTIVATED"
            ],
            "transactionMade": false,
            "orderStatus": "ORDER_PLACED",
            "orderId": "4UOO1ER8E6SV000",
            "network": "VISA_DPS",
            "isReIssue": false,
            "isReplace": false,
            "externalCardId": "v-401-27c8bce1-1178-4282-8541-ae8401e65d0e",
            "cardCreatedYear": "2024",
            "orderSubStatus": "ORDER_PENDING",
            "accountName": "David Savings Account",
            "customerName": "David Test"
        },
        "api": {
            "type": "REPLACE_CARD_ACK",
            "reference": "REFvisadps100017",
            "dateCreated": 1732087711,
            "originalReference": "visadps100017"
        }
    }
}